Skip to content

docs: Fix spelling errors in Core, GameEngineDevice, Libraries, and Tools comments #2147

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
bobtista wants to merge 11 commits into
base: main
Choose a base branch
from
Open

docs: Fix spelling errors in Core, GameEngineDevice, Libraries, and Tools comments #2147

bobtista wants to merge 11 commits into from

Conversation

@bobtista
Copy link

@bobtista bobtista commented Jan 18, 2026 •
edited
Loading

Fix spelling errors in code comments.

Covers:

  • Core/GameEngine/
  • Core/GameEngineDevice/
  • Generals/Code/GameEngineDevice/
  • Generals/Code/Libraries/
  • Generals/Code/Tools/
  • GeneralsMD/Code/GameEngineDevice/
  • GeneralsMD/Code/Libraries/
  • GeneralsMD/Code/Tools/

@greptile-apps
Copy link

greptile-apps bot commented Jan 18, 2026 •
edited
Loading

Greptile Overview

Greptile Summary

This PR fixes spelling errors in code comments across 66 files in the Core, Generals, and GeneralsMD directories. All changes are documentation-only, with no logic or code modifications.

Key Changes:

  • Common spelling corrections: implemenation → implementation, exisiting → existing, specifc → specific, overrided → overridden
  • Fixed typos in W3D graphics engine comments: texure → texture, columes → columns, efficienty → efficiently
  • Corrected particle system and UI-related typos: partcle → particle, componenets → components, environement → environment
  • All corrections are linguistically accurate and improve code documentation quality

Scope Covered:

  • Core/GameEngine/ - Base engine interfaces and implementations
  • Core/GameEngineDevice/ - Device-specific engine code
  • Generals/ and GeneralsMD/ - Game-specific implementations for vanilla and Zero Hour
  • Libraries/WWVegas/WW3D2/ - W3D graphics library
  • Tools/GUIEdit/ - GUI editing tool

The changes are safe, non-functional, and improve documentation readability without affecting runtime behavior.

Confidence Score: 5/5
  • This PR is completely safe to merge with zero risk
  • All 66 files contain only comment/documentation changes with correct spelling fixes and no code logic modifications
  • No files require special attention - all changes are documentation-only

Important Files Changed
Filename Overview
Core/GameEngine/Include/Common/AudioEventRTS.h Fixed spelling errors in comments: 'specifc' → 'specific', 'overrided' → 'overridden', completed incomplete comment
Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/Shadow/W3DVolumetricShadow.cpp Fixed spelling errors: 'efficienty' → 'efficiently', 'onces' → 'ones', 'columes' → 'columns'
Generals/Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DAssetManager.cpp Fixed spelling: 'exisiting' → 'existing' in two locations
Generals/Code/Libraries/Source/WWVegas/WW3D2/meshmdlio.cpp Fixed spelling: 'coordiantes' → 'coordinates', 'coordiante' → 'coordinate'
Generals/Code/Tools/GUIEdit/Source/GUIEdit.cpp Fixed spelling errors: 'cofig' → 'config', 'componenets' → 'components', 'beyong' → 'beyond'

Sequence Diagram

 
sequenceDiagram
    participant Dev as Developer
    participant Files as Source Files
    participant Comments as Code Comments
    participant PR as Pull Request
    
    Dev->>Files: Identify spelling errors in comments
    Files->>Comments: Read existing comments
    Comments-->>Dev: Return misspelled words
    Dev->>Comments: Fix spelling errors
    Note over Comments: specifc → specific<br/>overrided → overridden<br/>implemenation → implementation<br/>exisiting → existing<br/>etc.
    Dev->>Files: Update comments in 66 files
    Files-->>PR: Submit changes
    Note over PR: Only comment changes<br/>No logic modifications<br/>Consistent across all files
Loading

@xezon xezon added the Documentation Is documentation or complementary resource label Jan 19, 2026
xezon
xezon reviewed Jan 19, 2026
View reviewed changes
@bobtista bobtista force-pushed the fix/typos-include-device-libs-tools branch from 52e144d to 9a95d76 Compare January 19, 2026 21:12
xezon
xezon approved these changes Jan 19, 2026
View reviewed changes
Copy link

@xezon xezon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Daily dose of Bobtista changes

@xezon
Copy link

xezon commented Jan 22, 2026

I do not understand the splitting of this change. The title claims one thing, but the actual changes files are in all sorts of unrelated folders that do correspond to what the title says.

@bobtista bobtista changed the title docs: Fix spelling errors in Include, GameEngineDevice, Libraries, and Tools comments docs: Fix spelling errors in Core and Generals/Include/GameEngineDevice/Libraries/Tools comments Jan 22, 2026
greptile-apps[bot]
greptile-apps bot reviewed Jan 22, 2026
View reviewed changes
Copy link

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

120 files reviewed, 2 comments

Edit Code Review Agent Settings | Greptile

@bobtista
Copy link
Author

bobtista commented Jan 22, 2026

I do not understand the splitting of this change. The title claims one thing, but the actual changes files are in all sorts of unrelated folders that do correspond to what the title says.

I think it's because there were multiple commits, and main has changed, I bet if I rebase and squash it's clean

@bobtista bobtista force-pushed the fix/typos-include-device-libs-tools branch from 009d817 to e5ef95a Compare January 22, 2026 21:29
xezon
xezon reviewed Jan 29, 2026
View reviewed changes
Generals/Code/GameEngine/Include/Common/Energy.h
Copy link

@xezon xezon Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This Pull contains edits to Generals/Core/GameEngine/Include

Wouldn't that fit better into #2145, which also touched this portion?

Copy link
Author

@bobtista bobtista Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, I moved those changes there.

xezon
xezon reviewed Jan 29, 2026
View reviewed changes
Generals/Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DGadget.h
Copy link

@xezon xezon Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why does this Pull touch code in Generals, when there is no other Pull that touches equivalent files for Zero Hour?

Copy link
Author

@bobtista bobtista Jan 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the fixes I could find here to this PR, it's still less than 100 files touched

@bobtista bobtista force-pushed the fix/typos-include-device-libs-tools branch from b68e07b to 7141d5b Compare January 29, 2026 23:10
@bobtista bobtista changed the title docs: Fix spelling errors in Core and Generals/Include/GameEngineDevice/Libraries/Tools comments docs: Fix spelling errors in Core, GameEngineDevice, Libraries, and Tools comments Jan 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xezon xezon xezon approved these changes

+1 more reviewer

@greptile-apps greptile-apps[bot] greptile-apps[bot] left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Documentation Is documentation or complementary resource

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bobtista @xezon